#region license
# This file is part of Grawlix.
# 
# Grawlix is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of
# the License, or (at your option) any later version.
# 
# Grawlix is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public
# License along with Grawlix.  If not, see
# <http://www.gnu.org/licenses/>.
#endregion

"""Glyph object for specifying what to render."""

namespace Grawlix.Services.Rendering
import Grawlix
import Grawlix.Meta
import System

struct Glyph:
"""Glyph positioning and index."""
	
	[Equality]
	private def Equality(rhs as Glyph):
	"""
	Equality testing.
	Returns: true if equal, else false.
	"""
		return (Position == rhs.Position and Character == rhs.Character)
	
	override def GetHashCode():
	"""
	Get a hash code based on current value.
	Returns: The hash code.
	"""
		return _position.GetHashCode() ^ _character.GetHashCode()
	
	override def ToString():
	"""
	Get a string representation for this object.
	Returns: A string representation for this object.
	"""
		return "Glyph ${_character}"
	
	[property(Position)]
	private _position as Vector
	"""
	Position of the glyph within
	the rendered box, in pixels.
	"""
	
	[property(Character)]
	private _character as int
	"""Index of the glyph."""

